Documenting C code

For documenting C code, we use Doxygen. Find the internal notes on Doxygen here. These are tested on Ubuntu 20.02 LTS machine

Installation

1. Download a compatible binary of Doxygen from this page. This is the binary I used, which was the latest binary compatible for Ubuntu 64bit

   wget https://www.doxygen.nl/files/doxygen-1.9.7.linux.bin.tar.gz

2. Uncompress and unpack the downloaded archive. Replace the name of the archive as necessary.

   gunzip doxygen-1.9.7.linux.bin.tar.gz 
   tar xf doxygen-1.9.7.linux.bin.tar

3. Install the binary

   cd doxygen-1.9.7/
   make install

Comments syntax

A nice tutorial on writing Doxygen compatible comments can be found here.